home *** CD-ROM | disk | FTP | other *** search
/ MacWorld 1998 May / Macworld (1998-05).dmg / Shareware World / Comms & Internet / ProTERM_1.2.5.Install / ProTERM Mac1.2.5 / Help / Dot-Commands Defined < prev    next >
Text File  |  1998-02-13  |  17KB  |  302 lines

  1. ****** ProTERM HELP FILE ******
  2.        =================
  3.  
  4. •Dot-Commands Examples and Instructions
  5.  
  6. ***** Quick Index *****
  7.  
  8.  • ProTERM's Quick Index is available for this document.
  9.    When this file is opened from a ProTERM Help menu, a small table of
  10.    contents or "Index" window also opens to the right of this window: ===>>
  11.    Double-click any subject header in the Quick Index window to locate that
  12.    subject header here. Use the Quick Index window as a quick navigator tool.
  13.  
  14.  • Create Quick Indexes for your own ProTERM documents. For help on this
  15.    and other features, choose Help from the Apple menu (upper left corner).
  16. ** ——— **
  17.  
  18. ***** Why Dot-Commands *****
  19.  
  20. While ProTERM is not formally a word processing application, the ProTERM editor is extremely robust, can open most any document, and has basic formatting commands called dot-commands. Dot-commands allow a powerful mode of basic page layout, such as left and right margins, paragraph margins (indent and hanging), justification and line spacing. All of the documents in the ProTERM Help files are formatted with dot-commands. When the documents are opened directly from the ProTERM Help folder or the PTMM Help folder using the Open command from the File menu, you will see the documents in their “raw” unformatted form, and with the dot-commands visible. Look through some of them (including this one) for example formatting.
  21.  
  22. ***** Formatting of =This= Document *****
  23.  
  24. Parts of this document are preformatted, (some actual dot-commands are not used in this document). The reason is because this document is in the ProTERM Help menu, and the Help menu folder has special properties that cause a file to be automatically formatted as set by any embedded commands (which is what this file is all about. So we had to use some license in how to format this document. Many examples of dot-command formatting are shown with a TILDE character instead of the normal ORDMASCULINE character, because we wanted to show which command is causing what you see. More details follow below. See “Faux Commands”
  25.  
  26. ProTERM's dot-commands provide a unique method of easily performing sophisticated, and even complex ASCII text formatting.
  27.  
  28. ~LM3~~PM-2~~RM-10~
  29. ºLM3ººPM-2ººRM-10º
  30. o Just as an artist can successfully paint using just one color, ProTERM is perfectly capable of printing and uploading text without the use of dot-commands.
  31. o However, like an artist's palette, dot-commands give depth, character, and style to a "flat-white" document.
  32. o These extraordinary power tools give the user additional levels of command over transferred or printed text, and text to be read on the screen. In addition, any file containing dot-commands that is placed in a ProTERM Help folder automatically shows the special formatting, when the file is opened from a ProTERM Help menu. In addition, the files in a Help folder can even show an Index of the file.
  33. o Placing a dot-command on a page (referred to as "embedding" the command) allows formatting of left and right margins, center justification, indented or 'hanging' paragraphs, page numbering, forced form feeds and much more.
  34. ºLMººPMººRM+10º
  35. ~LM~~PM~~RM+10~
  36.  
  37. **** Overview ****
  38.  
  39. Dot-commands are created by placing special instructions between sets of special characters named the ordmasculine character. This character is created with the OPTION+ZERO keys. An ordmasculine looks like a little underlined ohh, or “degree” mark. These characters are unique and likely different from anything else normally found in a text document.
  40.  
  41. Dot-command instructions are simple two-letter commands and some commands can also include numbers. Dot-commands are recognized as special instructions when the ordmasculine and dot-command instructions are presented in a special format. The combination creates dot-commands that are recognized by ProTERM as formatting instructions. 
  42.  
  43. The commands are mnemonic (intended to assist the memory), because they look like what they do) and are easy to remember. Commands such as LM=Left Margin, RM=Right Margin, PM=Paragraph Margin, or -RM5 as well as +RM5 which can subtract and add to the current setting of the command, are magically converted into special text handling and formatting instructions as their characters imply.
  44.  
  45. Dot-commands are not case sensitive, and can be in UPPERcase, lowercase, or mixed. The actual dot-command instructions in this text are shown as uppercase because its easier to distinguish certain characters when viewed in uppercase.
  46.  
  47. **** Faux Commands ****
  48. (faux adj. false or imitation)
  49. SPECIAL NOTE ON USE OF “FAUX” COMMANDS:
  50. Where dot-commands examples are used as example, and in discussion here, some the dot-commands in those examples are substituted with false or “faux” TILDE character (~), because some of the needed commands within the text and out of context cause the formatting of the document to go out of control. Wherever you see a command with a TILDE, understand that the TILDE is an implied ordmasculine “dot-command” (OPTION+ZERO) character.
  51.  
  52. EXAMPLE: This next, and many other example paragraphs are set up with both, the faux and real ordmasculine characters. If you open this file directly from the ProTERM Help menu, you can select the example sets of dot-commands in this document, such as the following sample text, then choose Format Test from the Edit menu to see the results:
  53.  
  54. ~LM10~   ~RM70~  ~CJ~
  55. ºLM10º   ºRM70º  ºCJº
  56. These three commands, respectively set the left margin to 10, the right margin to 70, and center justify (center) the text on the page.
  57. ºLM0ººRM80ººLJº
  58. ~LM0~~RM80~~LJ~     ~REM “These commands counter the above commands”~
  59.                     ~REM “resetting the values back to normal.”~
  60.             ~REM “(The REM command allows hidden comments.)”~
  61. Rules:
  62.  o While dot-commands can be embedded in text, desired results are not
  63.    guaranteed unless the dot-commands occupy a clear line.
  64.  o The commands can be placed anywhere on the line they occupy, that is, they
  65.    do not need to touch the left margin.
  66.  o They can be adjacent to each other or separated.
  67.  o Dot-commands must be enclosed within its own pair of ordmasculine
  68.    characters. When using commands in combination, one after the other,
  69.    be sure each command is enclosed within its own set of ordmasculines.
  70.  o One command can be added to, or subtracted from by a following command. That
  71.    is, a command that set the left margin to 10 ~LM10~ would be cancelled if a
  72.    following command set ~LM0~ or set to left margin 20 if the ~LM10~ command
  73.    were entered a second time.
  74.  
  75. After applying the commands, select the text to be affected, and chose Format Test from the Edit menu to check your work.
  76.  
  77. EXAMPLE: Select the following dot-commands and the text from the following
  78.          two paragraphs, and choose Format Test from the Edit menu to see 
  79.          the results of the following dot-commands:
  80. ~LM7~~PM-4~
  81. ºLM7ººPM-4º
  82. The text following the dot-commands is automatically formatted as shown in this example. This command tells ProTERM to use a Left Margin of 7 (LM7) for the following text and a Paragraph Margin of minus 4 (PM-4) This sets the left margin to 7 but whenever a new paragraph begins, the first line of the new paragraph “hangs” out four columns into the left margin because of PM-4 dot-command sets the beginning of the paragraph to minus four columns left of the set paragraph margin.
  83.  
  84. ~RM70~
  85. ºRM70º
  86. Note that the dot-commands from the above paragraph also effect this paragraph. Also note that a right margin control is added to this paragraph, so this paragraph is set in from the left margin. ~RM-10~ would set the same margin, because that would subtract 10 columns from the afore set 80 column right margin. The right margin can be reset by using ~+RM10~ or ~RM80~, both would cause the same effect. The dot-commands following this paragraphs counteracts their leading counterpart commands, and sets the changed margins back to zero and 80. They are the same as if LM0 and PM0 (the “0” is zero — not uppercase ohhs). The right margin is also set back to 80. As you may note, ~LM~ and ~LM0~ are the same command.
  87. ºLMººRM80ººPMº
  88. ~LM~~RM80~~PM~
  89.  
  90. ***** Dot Command Types *****
  91.  
  92. **** Reply Format ****
  93.  __________
  94.  |>...... |    Reply Commnt On     ~RE(" > ")~
  95.  |>...... |    Reply Commnt Off ~RE~
  96.  |>.......|
  97.  |________|
  98.  
  99. EXAMPLE: Select the following dot-commands and text, and choose
  100.         Format Test from the Edit menu to see the results:
  101.  
  102. ~RE(“ > ”)~
  103. ºRE(“ > ”)º
  104. The above command begins a Reply Format using a “>” for a reply character.
  105. A couple of often used and valuable dot-commands, the “reply commands” are set up for use as Function keys F-1 and F-2. This set loads from the default macro set when ProTERM is launched. If you do not have an extended keyboard with “F-Keys,” choose the Function key palette from the Tools menu and try F-1 before a paragraph, and F-2 following the paragraph. 
  106. The command just below, turns the Reply Format command off.
  107. ºREº
  108. ~RE~
  109.  
  110. **** Justification Control ****
  111.  __________
  112.  |  ...   |     Cent Justify    ~CJ~
  113.  |....... |
  114.  | .....  |
  115.  |________|
  116.  __________
  117.  | ...... |     Left Justify   ~LJ~
  118.  | ....   |
  119.  | ...... |
  120.  |________|
  121.  __________
  122.  |   .... |     Right Justify   ~RJ~
  123.  | ...... |
  124.  | ...... |
  125.  |________|
  126.  
  127.  ~CJ~   Center Justify all subsequent text.
  128.  ~RJ~   Right Justify all subsequent text.
  129.  ~LJ~   Left Justify all subsequent text.
  130.  
  131.  
  132. **** Margin Control ****
  133.  
  134. It is often convenient to set a margin by subtracting a number from the set value being used and then adding a offsetting number back using a plus value. Example: Assuming the set value is 80 and the margin is to be reset at to 75. The two choices available are:
  135. ºlm4ººpm-4º
  136.  1- ~RM75~ and then ~RM80~ to reset to the original value.
  137.  2- The alternative method is to use ~RM-5~ and then ~RM+5~ to reset the original margin. 
  138. ºlmººpmº
  139.  
  140. Either achieves the same result. They could of course be used in combination e.g., ~RM75~  and then to reset use ~RM+5~ which achieves the same result mentioned above.
  141.  
  142.  
  143. *** Left Margin Control ***
  144.  
  145.    ~LM~    Set Left Margin to normal (default).
  146. ~LMxxx~    Number of characters from the left edge of the page to the start 
  147.            of the text (the default is 0).
  148. ~LM-xxx~   Decrease Left Margin minus xxx chars.
  149. ~LM+xxx~   Increase Left Margin xxx chars.
  150.  
  151.  
  152. *** Right Margin Control ***
  153.  
  154.     ~RM~   Set Right Margin to normal (default).
  155.  ~RMxxx~   Number of characters from the left edge of the page to the end
  156.            of the text. The default is the page width, minus the Left and
  157.            Right Margin value as specified in the Print Parameters window.
  158.            The normal screen width of 80 columns is usually the default.
  159. ~RM+xxx~   Set Right Margin plus xxx characters.
  160. ~RM-xxx~   Decrease Right Margin minus xxx chars.
  161.  
  162. *** Paragraph Margin Control ***
  163.  
  164. ~LM10~~PM-10~
  165. ºLM10ººPM-10º
  166.      ~PM~ Set Paragraph Margin to normal (default).
  167.   ~PMxxx~ Number of characters (positive or negative) from the left margin to the start of the text on the first line of a paragraph; this parameter can be used to create either indented or hanging paragraphs (the default is 0 or just ~PM~ with no value).
  168.  ~PM-xxx~ Increase Paragraph Margin left xxx chars.
  169.  ~PM+xxx~ Increase Paragraph Margin right xxx chars.
  170. ºLM-10ººPM-10º
  171. ~LM-10~~PM-10~
  172.  
  173. **** New Page (Page Form Feed) ****
  174.  
  175. The Control-L character creates a form feed, or page feed. This command MUST be on a line by itself. Form feeds are created by pressing and holding the CONTROL key down while pressing the L key. Control-L characters can be viewed two ways by clicking the Paragraph show icon in the lower left corner of the ProTERM document window. Control-L characters can be anywhere in a document, but the effect is, that at the point of the CONTROL+L, a new page is started. When a CONTROL+L is sent to the printer, the printer ”form-feeds+ that page, and starts a new page.
  176.  
  177. **** Controls That Hide Text ****
  178.  
  179.         ~HIDE~  Hide all subsequent text.
  180.         ~SHOW~  Show all subsequent text.
  181.  
  182.      ~DISABLE~  Disable printer for all subsequent text.
  183.       ~ENABLE~  Enable printer for all subsequent text.
  184.  
  185.   ~REM “TEXT”~    Hide up to about 240 characters. The text must be between
  186.                 quotes and is followed by an ordmasculine. 
  187.  
  188. Invisible REM statements hide next 240 characters in a paragraph. REM statements are used as “reminder” statements and are hidden when text is printed, uploaded or when shown using the Format Command.
  189.  
  190. Reminder Command  ~REM “Place text to be hidden here.”~
  191.           ~REM “The text must be between quotes.”~
  192.  
  193. **** Hanging Paragraph ****
  194.  
  195. ~lm9~~pm-9~
  196. ºlm9ººpm-9º
  197. EXAMPLE: The following dot-commands and text, show a whole different set of formatting, and just one of many ways to handle hanging paragraphs. First the text is shown with faux commands in place, and then the formatted set is shown as an example. 
  198. ºlmººpmº
  199. ~lm~~pm~
  200.  
  201. ~LM7~~PM-4~~RM75~
  202. (a) A critic is a person that never goes to the battle, but arrives later to shoot the wounded.
  203. (b) ASCII - Ancient god of Telecommunications. Rumored to give vast amounts of data to believers. Hence, the phrase ASCII and you shall receive.
  204. (c) Everybody gotta do something. I ended up doin a whole lot of different things. But I enjoy what I am doin now ... and I'm goin to stay doin it ... as long as I can stay doin it. If you dig it, do it, and if you really dig, do it twice! —Jim Croce 1943-1973
  205. ~LM~~PM~
  206.  
  207. When the above dot-commands are invoked, the above text looks like this:
  208.  
  209.   (a) A critic is a person that never goes to the battle, but arrives
  210.       later to shoot the wounded.
  211.   (b) ASCII - Ancient god of Telecommunications. Rumored to give vast
  212.       amounts of data to believers. Hence, the phrase ASCII and you shall
  213.       receive.
  214.   (c) Everybody gotta do something. I ended up doin a whole lot of
  215.       different things. But I enjoy what I am doin now ... and I'm goin
  216.       to stay doin it ... as long as I can stay doin it. If you dig it,
  217.       do it, and if you really dig, do it twice! —Jim Croce 1943-1973
  218.  
  219. ProTERM actually does this magic formatting on the fly. Whether printing or sending ASCII text, or just using the Format Test command from the Edit menu, ProTERM formats the text automatically. The Format Test command does not need to be used before sending the text to the printer, as an ASCII upload, ProTERM interprets the commands during processing.
  220.  
  221. Try it yourself. Select the unformatted paragraph above, and choose Format Test from the Edit menu.
  222.  
  223. ***** In Case of Difficulty *****
  224.  
  225. If you try using a dot-command and the reformatted lines all stagger and the text seems to be a jagged mess, the problem is that there is a hard return character on the end of each line, so every line is an individual paragraph. This formatting is called “line-format” and all text from online service visits will be made up of line-formatted text. This is easy to deal with after converting the text to paragraph format.
  226.  
  227. Change from Line Format to Paragraph Format -
  228. Select the text and choose Paragraph Format from the Edit > Convert menu.
  229.  
  230.  
  231. ***** Shortcut Tip *****
  232.  
  233. Instead of creating one ordmasculine, typing the dot-command and then creating another ordmasculine, create two ordmasculines, and then insert the command between the pair of characters - its just quicker.
  234.  
  235. ***** Dot Command Summary *****
  236.  
  237. ~LM6~~RM70~~RM70~
  238. ºLM7ººPM-6ººRM70º
  239. NOTE: Ordmasculine not used in this example because of their effect on uploaded text. Replace tilde with ordmasculine (Cmd+Opt+Zero) (zero on keyboard keys not number keypad keys.)
  240. ºLMººRM80ººPM0º
  241. ~LM~~RM80~~PM0~
  242. _____________________________________________________________________
  243.        Dot-Command Tools Palette (concept)
  244.  
  245. Examp Format   Format Function     Example Command
  246. _____________________________________________________________________
  247. Margin Control Command -
  248.     |==> Left Margin    ~LMxxx~
  249.     |<== Left Margin    ~LM-xxx~
  250.  
  251.     <==| Right Margin    ~RMxxx~
  252.     ==>| Right Margin    ~RM-xxx~
  253.  
  254.  Paragraphs Control Command -                __________
  255.     =>Par. IndentBeg     ~PMxx~            |   .... |
  256.       Par. IndentStop    ~PM-xx~            | ...... |
  257.                             | ...... |
  258.                             |________|
  259.                             __________
  260.     <=Par. HangingBeg    ~PM-xx~         |....... |
  261.     <=Par. HangingStop    ~PMxx~             |  ..... |
  262.                             |  ..... |
  263.                             |________|
  264. Reply Comment Control Command                 __________
  265.     Reply Commnt On        ~RE(" > ")~        |>...... |
  266.     Reply Commnt Stop    ~RE~            |>...... |
  267.                             |>...... |
  268.                             |________|
  269. Justify Control Command -                __________
  270.     Cent Justify        ~CJ~            |  ...   |
  271.                             |....... |
  272.                             | .....  |
  273.                             |________|
  274.                             __________
  275.     Left Justify        ~LJ~            | ...... |
  276.                             | ....   |
  277.                             | ...... |
  278.                             |________|
  279.                             __________
  280.     Right Justify        ~RJ~            |   .... |
  281.                             | ...... |
  282.                             | ...... |
  283.                             |________|
  284.  
  285. ---
  286.  
  287. Let us know how ProTERM works for you.
  288.  
  289.  InTrec Software, Inc.   Sales ___________________        Tech ______
  290.  3035 E Topaz Circle     1888/PROTERM tollfree USA   Voc:602/992-1345
  291.  Phoenix, AZ 85028-4423  602/992-5515 outside USA    BBS:602/992-9789
  292.  Fax:602/992-0232        sales@intrec.com          proterm@intrec.com
  293.  URL <http://www.intrec.com>   FTP <ftp://ftp.intrec.com/pub/intrec/>
  294.    - Creative Macintosh and Apple II telecommunications solutions -
  295.  
  296. As always, if we can help... Ask! ;-)  Your questions help us add quality.
  297. Send a note to: proterm@intrec.com
  298.  
  299.  Last Updated: Feb 13, 1998
  300.  ©1994-98 InTrec Software, Inc.
  301.  Jerry Cline & Greg Schaefer
  302.